geotiff: read_geotiff_dask honours default max_pixels region cap (#1838)#1839
Merged
Conversation
read_geotiff_dask documents that max_pixels=None uses the module default cap, but the up-front region guard was gated on max_pixels is not None and silently skipped when None was passed. Per-chunk reads still applied MAX_PIXELS_DEFAULT, and the VRT chunked path already substituted the default before its up-front guard, so only the GeoTIFF dask path was inconsistent: callers could build a lazy graph over a region far larger than the documented safety cap, with the oversize error deferred to compute time. Substitute MAX_PIXELS_DEFAULT for None before the guard so eager, VRT, and dask paths share the same upfront safety semantics.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR makes read_geotiff_dask honor its documented default max_pixels cap during the up-front lazy-region guard, aligning GeoTIFF dask reads with eager and VRT chunked paths.
Changes:
- Substitutes
MAX_PIXELS_DEFAULTwhenmax_pixels=Nonebefore checking the requested dask region size. - Adds regression tests for default cap enforcement, explicit cap enforcement, and normal small reads.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
xrspatial/geotiff/__init__.py |
Applies an effective max_pixels value before the dask region size guard. |
xrspatial/geotiff/tests/test_dask_max_pixels_default_guard_1838.py |
Adds coverage for the corrected default-cap behavior in read_geotiff_dask. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1838.
Summary
read_geotiff_daskdocuments thatmax_pixels=Noneuses the module default cap, but the up-front region guard at__init__.py:2462gated onmax_pixels is not Noneand silently skipped whenNonewas passed.MAX_PIXELS_DEFAULT, and the VRT chunked path substituted the default before its up-front guard, so only the GeoTIFF dask path was inconsistent. Callers could construct a lazy graph far larger than the documented safety cap, with the oversize error deferred to compute time.MAX_PIXELS_DEFAULTforNonebefore the guard so eager, VRT, and dask paths share the same up-front safety semantics.Test plan
test_dask_max_pixels_default_guard_1838.pycover the default-cap guard, the explicit-cap guard, and verify normal small reads are unaffected.